home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / VkFLM.z / VkFLM
Encoding:
Text File  |  2002-10-03  |  9.1 KB  |  199 lines
  1.  
  2.  
  3.  
  4. VVVVkkkkFFFFLLLLMMMM((((3333xxxx))))                                                            VVVVkkkkFFFFLLLLMMMM((((3333xxxx))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      VkFLM - FLEXlm License Management
  10.  
  11. HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
  12.      #include <Vk/VkFLM.h>
  13.  
  14. PPPPUUUUBBBBLLLLIIIICCCC PPPPRRRROOOOTTTTOOOOCCCCOOOOLLLL SSSSUUUUMMMMMMMMAAAARRRRYYYY
  15.    CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr////DDDDeeeessssttttrrrruuuuccccttttoooorrrr
  16.            VkFLM( VENDORCODE*, char *, char *, char *, long );
  17.  
  18.            void ~VkFLM (void);
  19.  
  20.  
  21. XXXX RRRREEEESSSSOOOOUUUURRRRCCCCEEEESSSS AAAASSSSSSSSOOOOCCCCIIIIAAAATTTTEEEEDDDD WWWWIIIITTTTHHHH TTTTHHHHIIIISSSS CCCCLLLLAAAASSSSSSSS
  22.            enterLicenseMessage
  23.            disableLicenseWarnings
  24.            disableThirtyDayLicenseWarnings
  25.            thirtyDayMessage
  26.            sixtyDayMessage
  27.            ninetyDayMessage
  28.            noLicenseMessage
  29.            noLicenseServerMessage
  30.            notEnoughLicensesMessage
  31.            licenseExpiredMessage
  32.            loseLicenseMessage
  33.            warnLoseLicenseMessage
  34.            regainLicenseMessage
  35.  
  36.  
  37. CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  38.           VkFLM provides a high-level interface to the FLEXlm network
  39.           licensing manager.  The VkFLM class implements a policy based on the
  40.           FLEXlm license mechanism that simplifies the process of license
  41.           protecting applications.  Applications merely instantiate a VkFLM
  42.           object in their application, providing some basic information about
  43.           the application and its licensing.  The VkFLM object handles all
  44.           license verification, informing the user if there is a problem, and
  45.           shutting the application down if a license cannot be found.
  46.  
  47.           VkFLM will look for either a node-locked or network (concurrent)
  48.           license.  There is no difference to the application for these
  49.           different types of licenses.  Once the VkFLM object is instantiated,
  50.           the object immediately checks for a valid license.  If no license is
  51.           found, the object posts a fatal error dialog, which the user must
  52.           dismiss, exiting the application.
  53.  
  54.           If a license is obtained, the license is rechecked every ten
  55.           minutes.  If the application's license is lost, a warning dialog is
  56.           posted warning that the license is no longer valid.  This dialog is
  57.           posted in blocking mode, so the user must dismiss it, however, the
  58.           application will not exit.  Instead, the object begins checking
  59.           every minute for a license.  If the license is restored, a dialog is
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. VVVVkkkkFFFFLLLLMMMM((((3333xxxx))))                                                            VVVVkkkkFFFFLLLLMMMM((((3333xxxx))))
  71.  
  72.  
  73.  
  74.           posted notifying the user, and the program returns to normal
  75.           operation.  If the license is not found, another blocking dialog is
  76.           posted every minute.
  77.  
  78.           The VkFLM class also supports warnings for users whose licenses are
  79.           about to expire.  By default, VkFLM will post a warning when a
  80.           license has less than 90 days before expiration.
  81.  
  82. RRRREEEESSSSOOOOUUUURRRRCCCCEEEESSSS
  83.      VkFLM recognizes several X resources that control the messages posted by
  84.      the various dialogs.  These are:
  85.  
  86.    eeeennnntttteeeerrrrLLLLiiiicccceeeennnnsssseeeeMMMMeeeessssssssaaaaggggeeee
  87.      If there is an entry in the license file that is valid except for the
  88.      password, the user will be prompted to supply a valid password.  This
  89.      resource is the prompt that will be displayed when the password is
  90.      requested.  It is usual to put the full name and version number of the
  91.      product in the prompt.
  92.  
  93.    ddddiiiissssaaaabbbblllleeeeLLLLiiiicccceeeennnnsssseeeeWWWWaaaarrrrnnnniiiinnnnggggssss
  94.      If TRUE, don't show the warnings that appear when a license has only 90
  95.      days before expiration.  The default is FALSE.  This resource does not
  96.      disable messages when the license has less than 30 days before
  97.      expiration.
  98.  
  99.    ddddiiiissssaaaabbbblllleeeeTTTThhhhiiiirrrrttttyyyyDDDDaaaayyyyLLLLiiiicccceeeennnnsssseeeeWWWWaaaarrrrnnnniiiinnnnggggssss
  100.      If TRUE, don't show the warnings that appear when a license has only 30
  101.      days before expiration.  The default is FALSE.
  102.  
  103.    tttthhhhiiiirrrrttttyyyyDDDDaaaayyyyMMMMeeeessssssssaaaaggggeeee
  104.      Determines the message to appear when only 30 days or less are left
  105.      before a license expires.  The message is expected to embed a "%d"
  106.      printf-style integer spec in the message.  VkFLM will plug the correct
  107.      number of days into this slot.  For example:
  108.  
  109.           *thirtyDayMessage: Your license will expire in %d days.
  110.  
  111.  
  112.    ssssiiiixxxxttttyyyyDDDDaaaayyyyMMMMeeeessssssssaaaaggggeeee
  113.      Determines the message to appear when between 60 and 30 days are left
  114.      before a license expires.  The message is expected to embed a "%d"
  115.      printf-style integer spec in the message.  VkFLM will plug the correct
  116.      number of days into this slot.
  117.  
  118.    nnnniiiinnnneeeettttyyyyDDDDaaaayyyyMMMMeeeessssssssaaaaggggeeee
  119.      Determines the message to appear when between 90 and 60 days are left
  120.      before a license expires.  The message is expected to embed a "%d"
  121.      printf-style integer spec in the message.  VkFLM will plug the correct
  122.      number of days into this slot.
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. VVVVkkkkFFFFLLLLMMMM((((3333xxxx))))                                                            VVVVkkkkFFFFLLLLMMMM((((3333xxxx))))
  137.  
  138.  
  139.  
  140.    nnnnooooLLLLiiiicccceeeennnnsssseeeeMMMMeeeessssssssaaaaggggeeee
  141.      Determines the message to appear when no valid license can be found.
  142.  
  143.    nnnnoooottttEEEEnnnnoooouuuugggghhhhLLLLiiiicccceeeennnnsssseeeessssMMMMeeeessssssssaaaaggggeeee
  144.      Determines the message to appear when an application is licensed, but
  145.      there are not enough licenses currently available to support the number
  146.      of people using them.
  147.  
  148.    lllliiiicccceeeennnnsssseeeeEEEExxxxppppiiiirrrreeeeddddMMMMeeeessssssssaaaaggggeeee
  149.      Determines the message to appear when an application has had a valid
  150.      license, but the license has now expired.
  151.  
  152.    wwwwaaaarrrrnnnnLLLLoooosssseeeeLLLLiiiicccceeeennnnsssseeeeMMMMeeeessssssssaaaaggggeeee
  153.      Determines the message to appear when an application has lost its license
  154.      while the application is running.
  155.  
  156.    lllloooosssseeeeLLLLiiiicccceeeennnnsssseeeeMMMMeeeessssssssaaaaggggeeee
  157.      Determines the message to appear when an application has lost its license
  158.      and is unable to regain the license.
  159.  
  160.    rrrreeeeggggaaaaiiiinnnnLLLLiiiicccceeeennnnsssseeeeMMMMeeeessssssssaaaaggggeeee
  161.      Determines the message to appear when an application that has lost its
  162.      license and has successfully regained the license.
  163.  
  164. FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
  165.    VVVVkkkkFFFFLLLLMMMM(((())))
  166.            VkFLM( VENDORCODE*, char *, char *, char *, long );
  167.  
  168.  
  169.           When instantiating a VkFLM object, applications must provide a
  170.           vendor code, the daemon name, the feature name, and the version
  171.           number.  The application may also supply an interval (in minutes)
  172.           for checks to make sure the license is still valid.
  173.  
  174.    ~~~~VVVVkkkkFFFFLLLLMMMM(((())))
  175.           void ~VkFLM(void);
  176.  
  177.  
  178.           Free all storage associated with a VkFLM object and return any
  179.           license currently in use.
  180.  
  181. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  182.      _F_L_E_X_l_m _E_n_d _U_s_e_r _M_a_n_u_a_l, _V_i_e_w_K_i_t _P_r_o_g_r_a_m_m_e_r'_s _G_u_i_d_e.
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.